<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>simTransformImage</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../../index.html" TARGET="_top"><img src="../images/homeImg.png"></a></p>

<h1><a href="../apiOverview.htm">Regular API</a> function</h1>
<h3 class=subsectionBar><a name="simTransformImage" id="simTransformImage"></a>simTransformImage / sim.transformImage </h3>
<table class=apiTable>
<tr class=apiTableTr> 
<td class=apiTableLeftDescr>
Description 
</td> 
<td class=apiTableRightDescr>Transforms an image in various ways. See also <a href="simLoadImage.htm">sim.loadImage</a>, <a href="simGetScaledImage.htm">sim.getScaledImage</a>, <a href="simTransformBuffer.htm">sim.transformBuffer</a> and <a href="simCombineRgbImages.htm">sim.combineRgbImages</a>.</td>
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCSyn>
C synopsis
</td> 
<td class=apiTableRightCSyn>simInt simTransformImage(simUChar* image,const simInt* resolution,simInt options,const simFloat* floatParams,const simInt* intParams,simVoid* reserved)</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCParam>C parameters</td> 
<td class=apiTableRightCParam>
<div><strong>image</strong>: a pointer to rgb or rgba values of the image</div>
<div><strong>resolution</strong>: the resolution of the image</div>
<div><strong>options</strong>: bit-coded:</div>
<div class=tab>bit0 set (1): the provided image is rgba (or a depth buffer, i.e. one float per image pixel), otherwise it is rgb</div>
<div class=tab>bit1 set (2): the image will be flipped on its x-axis</div>
<div class=tab>bit2 set (4): the image will be flipped on its y-axis</div>
<div><strong>floatParams</strong>: Reserved for future extension. Set to nullptr.</div>
<div><strong>intParams</strong>: Reserved for future extension. Set to nullptr.</div>
<div><strong>reserved</strong>: Reserved for future extension. Set to nullptr.</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCRet>
C return value
</td> 
<td class=apiTableRightCRet>
<div>-1 if operation was not successful.</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLSyn>
Lua synopsis
</td> 
<td class=apiTableRightLSyn>sim.transformImage(string image,table_2 resolution,number options)</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLParam>Lua parameters</td> 
<td class=apiTableRightLParam>
<div>Similar to the C-function counterpart</div></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLRet>
Lua return values
</td> 
<td class=apiTableRightLRet>
<div>none</div></td> 
</tr> 
</table> 

<br>
<p><a href="../apiFunctions.htm">All regular API functions on one page</a></p>
<br>
<br>
</td>
</tr>
</table>
</div>
</body>
</html>
